org.springframework.orm.hibernate3.support

Class HibernateDaoSupport

java.lang.Object

org.springframework.dao.support.DaoSupport

org.springframework.orm.hibernate3.support.HibernateDaoSupport

All Implemented Interfaces:

InitializingBean

Deprecated.

as of Spring 4.3, in favor of Hibernate 4.x/5.x

@Deprecated
public abstract class HibernateDaoSupport
extends DaoSupport

Convenient super class for Hibernate-based data access objects.

Requires a org.hibernate.SessionFactory to be set, providing a HibernateTemplate based on it to subclasses through the getHibernateTemplate() method. Can alternatively be initialized directly with a HibernateTemplate, in order to reuse the latter's settings such as the SessionFactory, exception translator, flush mode, etc.

This base class is mainly intended for HibernateTemplate usage but can also be used when working with a Hibernate Session directly, for example when relying on transactional Sessions. Convenience getSession() and releaseSession(Session) methods are provided for that usage style.

This class will create its own HibernateTemplate instance if a SessionFactory is passed in. The "allowCreate" flag on that HibernateTemplate will be "true" by default. A custom HibernateTemplate instance can be used through overriding createHibernateTemplate(SessionFactory).

NOTE: As of Hibernate 3.0.1, transactional Hibernate access code can also be coded in plain Hibernate style. Hence, for newly started projects, consider adopting the standard Hibernate3 style of coding data access objects instead, based on org.hibernate.SessionFactory#getCurrentSession().

Since:

1.2

Author:

Juergen Hoeller

See Also:

setSessionFactory(SessionFactory), getHibernateTemplate(), HibernateTemplate

Field Summary

Fields

Modifier and Type	Field and Description
private HibernateTemplate	hibernateTemplate Deprecated.

Fields inherited from class org.springframework.dao.support.DaoSupport

logger

Constructor Summary

Constructors

Constructor and Description
HibernateDaoSupport() Deprecated.

Method Summary

Modifier and Type	Method and Description
protected void	checkDaoConfig() Deprecated. Abstract subclasses must override this to check their configuration.
protected DataAccessException	convertHibernateAccessException(HibernateException ex) Deprecated. as of Spring 3.2.7, in favor of HibernateTemplate usage
protected HibernateTemplate	createHibernateTemplate(SessionFactory sessionFactory) Deprecated. Create a HibernateTemplate for the given SessionFactory.
HibernateTemplate	getHibernateTemplate() Deprecated. Return the HibernateTemplate for this DAO, pre-initialized with the SessionFactory or set explicitly.
protected Session	getSession() Deprecated. as of Spring 3.2.7, in favor of HibernateTemplate usage
protected Session	getSession(boolean allowCreate) Deprecated. as of Spring 3.2.7, in favor of HibernateTemplate usage
SessionFactory	getSessionFactory() Deprecated. Return the Hibernate SessionFactory used by this DAO.
protected void	releaseSession(Session session) Deprecated. as of Spring 3.2.7, in favor of HibernateTemplate usage
void	setHibernateTemplate(HibernateTemplate hibernateTemplate) Deprecated. Set the HibernateTemplate for this DAO explicitly, as an alternative to specifying a SessionFactory.
void	setSessionFactory(SessionFactory sessionFactory) Deprecated. Set the Hibernate SessionFactory to be used by this DAO.

Methods inherited from class org.springframework.dao.support.DaoSupport

afterPropertiesSet, initDao

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

hibernateTemplate

private HibernateTemplate hibernateTemplate

Deprecated.

Constructor Detail

HibernateDaoSupport

public HibernateDaoSupport()

Deprecated.

Method Detail

setSessionFactory

public final void setSessionFactory(SessionFactory sessionFactory)

Deprecated.

Set the Hibernate SessionFactory to be used by this DAO. Will automatically create a HibernateTemplate for the given SessionFactory.

See Also:

createHibernateTemplate(SessionFactory), setHibernateTemplate(org.springframework.orm.hibernate3.HibernateTemplate)

createHibernateTemplate

protected HibernateTemplate createHibernateTemplate(SessionFactory sessionFactory)

Deprecated.

Create a HibernateTemplate for the given SessionFactory. Only invoked if populating the DAO with a SessionFactory reference!

Can be overridden in subclasses to provide a HibernateTemplate instance with different configuration, or a custom HibernateTemplate subclass.

Parameters:

sessionFactory - the Hibernate SessionFactory to create a HibernateTemplate for

Returns:

the new HibernateTemplate instance

See Also:

setSessionFactory(SessionFactory)

getSessionFactory

public final SessionFactory getSessionFactory()

Deprecated.

Return the Hibernate SessionFactory used by this DAO.

setHibernateTemplate

public final void setHibernateTemplate(HibernateTemplate hibernateTemplate)

Deprecated.

Set the HibernateTemplate for this DAO explicitly, as an alternative to specifying a SessionFactory.

See Also:

setSessionFactory(SessionFactory)

getHibernateTemplate

public final HibernateTemplate getHibernateTemplate()

Deprecated.

Return the HibernateTemplate for this DAO, pre-initialized with the SessionFactory or set explicitly.

Note: The returned HibernateTemplate is a shared instance. You may introspect its configuration, but not modify the configuration (other than from within an DaoSupport.initDao() implementation). Consider creating a custom HibernateTemplate instance via new HibernateTemplate(getSessionFactory()), in which case you're allowed to customize the settings on the resulting instance.

checkDaoConfig

protected final void checkDaoConfig()

Deprecated.

Description copied from class: DaoSupport

Abstract subclasses must override this to check their configuration.

Implementors should be marked as final if concrete subclasses are not supposed to override this template method themselves.

Specified by:

checkDaoConfig in class DaoSupport

getSession

@Deprecated
protected final Session getSession()
                                        throws DataAccessResourceFailureException,
                                               java.lang.IllegalStateException

Deprecated. as of Spring 3.2.7, in favor of HibernateTemplate usage

Obtain a Hibernate Session, either from the current transaction or a new one. The latter is only allowed if the "allowCreate" setting of this bean's HibernateTemplate is "true".

Note that this is not meant to be invoked from HibernateTemplate code but rather just in plain Hibernate code. Either rely on a thread-bound Session or use it in combination with releaseSession(Session).

In general, it is recommended to use HibernateTemplate, either with the provided convenience operations or with a custom HibernateCallback that provides you with a Session to work on. HibernateTemplate will care for all resource management and for proper exception conversion.

Returns:

the Hibernate Session

Throws:

DataAccessResourceFailureException - if the Session couldn't be created

java.lang.IllegalStateException - if no thread-bound Session found and allowCreate=false

See Also:

SessionFactoryUtils.getSession(SessionFactory, boolean)

getSession

@Deprecated
protected final Session getSession(boolean allowCreate)
                                        throws DataAccessResourceFailureException,
                                               java.lang.IllegalStateException

Deprecated. as of Spring 3.2.7, in favor of HibernateTemplate usage

Obtain a Hibernate Session, either from the current transaction or a new one. The latter is only allowed if "allowCreate" is true.

Note that this is not meant to be invoked from HibernateTemplate code but rather just in plain Hibernate code. Either rely on a thread-bound Session or use it in combination with releaseSession(Session).

In general, it is recommended to use HibernateTemplate, either with the provided convenience operations or with a custom HibernateCallback that provides you with a Session to work on. HibernateTemplate will care for all resource management and for proper exception conversion.

Parameters:

allowCreate - if a non-transactional Session should be created when no transactional Session can be found for the current thread

Returns:

the Hibernate Session

Throws:

DataAccessResourceFailureException - if the Session couldn't be created

java.lang.IllegalStateException - if no thread-bound Session found and allowCreate=false

See Also:

SessionFactoryUtils.getSession(SessionFactory, boolean)

convertHibernateAccessException

@Deprecated
protected final DataAccessException convertHibernateAccessException(HibernateException ex)

Deprecated. as of Spring 3.2.7, in favor of HibernateTemplate usage

Convert the given HibernateException to an appropriate exception from the org.springframework.dao hierarchy. Will automatically detect wrapped SQLExceptions and convert them accordingly.

Delegates to the HibernateAccessor.convertHibernateAccessException(HibernateException) method of this DAO's HibernateTemplate.

Typically used in plain Hibernate code, in combination with getSession() and releaseSession(Session).

Parameters:

ex - HibernateException that occurred

Returns:

the corresponding DataAccessException instance

See Also:

SessionFactoryUtils.convertHibernateAccessException(HibernateException)

releaseSession

@Deprecated
protected final void releaseSession(Session session)

Deprecated. as of Spring 3.2.7, in favor of HibernateTemplate usage

Close the given Hibernate Session, created via this DAO's SessionFactory, if it isn't bound to the thread (i.e. isn't a transactional Session).

Typically used in plain Hibernate code, in combination with getSession() and convertHibernateAccessException(HibernateException).

Parameters:

session - the Session to close

See Also:

SessionFactoryUtils.releaseSession(Session, SessionFactory)